chore: formatting docstrings #717
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ana Basalo <ana.luiza.basalo@gmail.com>
anabasalo
requested review from
arnaudgeiser,
KingMob and
DerGuteMoritz
as code owners
|
Awesome! Thanks for taking care of this! |
|
Looks good so far. Thx! If you want to check how the tables look on cljdoc.org when rendered, I think you can feed it into a Github-Flavored Markdown tool. Check out https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc#docstrings and https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc#markup-formats for more. (Setting up a local cljdoc build of the docs is also doable, but involves convoluted Docker-fu.) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.